home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 5 / Gold Medal Software - Volume 5 (Gold Medal) (1995).iso / music / cds502.arj / CDSB.DOC next >
Text File  |  1993-12-07  |  47KB  |  892 lines

  1.                              CD SCAN Version 5.02
  2.                                 Budget Edition
  3.                            Copyright (c) 1992, 1993
  4.                                       By
  5.                               Joseph K. S. Dunn.
  6.                                       for
  7.                             Australian Intelligent
  8.                                Software Services
  9.                              All rights reserved.
  10.  
  11.                                   USER MANUAL
  12.                                 7 December 1993
  13.                                    CONTENTS
  14. Chapter                                                                   Page
  15.  
  16. CONTENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   2
  17.  
  18. Foreword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   3
  19.  
  20. Credits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   3
  21.  
  22. Disclaimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   4
  23.  
  24. Copyright Notice . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   4
  25.  
  26. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   5
  27.  
  28. 1 Installation and System Requirements . . . . . . . . . . . . . . . . . .   5
  29.  
  30. 2 How Cd Scan Works. . . . . . . . . . . . . . . . . . . . . . . . . . . .   6
  31.  
  32. 3 Starting the Program . . . . . . . . . . . . . . . . . . . . . . . . . .   6
  33.  
  34. 4 Entering a New Cd. . . . . . . . . . . . . . . . . . . . . . . . . . . .   7
  35.  
  36. 5 Exiting Cd Scan. . . . . . . . . . . . . . . . . . . . . . . . . . . . .   9
  37.  
  38. 6 Browsing Your Cd Collection. . . . . . . . . . . . . . . . . . . . . . .   9
  39.  
  40. 6.1 Re-sorting the Index . . . . . . . . . . . . . . . . . . . . . . . . .  10
  41.  
  42. 6.2 Deleting a Cd. . . . . . . . . . . . . . . . . . . . . . . . . . . . .  10
  43.  
  44. 7 Displaying a Cd. . . . . . . . . . . . . . . . . . . . . . . . . . . . .  11
  45.  
  46. 7.1 Editing a Cd . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  11
  47.  
  48. 7.2 Tagging and Pasting Tracks . . . . . . . . . . . . . . . . . . . . . .  12
  49.  
  50. 8 Creating and Viewing Lyrics. . . . . . . . . . . . . . . . . . . . . . .  13
  51.  
  52. 8.1 Summary of Display Symbols . . . . . . . . . . . . . . . . . . . . . .  14
  53.  
  54. 9 Searching. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  14
  55.  
  56. 10 Print Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  15
  57.  
  58. 10.1 Printing the Cd Index . . . . . . . . . . . . . . . . . . . . . . . .  15
  59.  
  60. 10.2 Printing the Full Catalogue . . . . . . . . . . . . . . . . . . . . .  16
  61.  
  62. 10.3 Viewing a Text File . . . . . . . . . . . . . . . . . . . . . . . . .  16
  63.  
  64. 10.4 Printing a text file. . . . . . . . . . . . . . . . . . . . . . . . .  16
  65.  
  66. 10.5 Printer Control . . . . . . . . . . . . . . . . . . . . . . . . . . .  17
  67.  
  68. 10.6 Notes about Printing. . . . . . . . . . . . . . . . . . . . . . . . .  17
  69.  
  70. 11 Utilities Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . .  17
  71.  
  72. 11.1 Optimising the Data File. . . . . . . . . . . . . . . . . . . . . . .  17
  73.  
  74. 11.2 Undeleting Cds. . . . . . . . . . . . . . . . . . . . . . . . . . . .  18
  75.  
  76. 11.3 Merging Catalogues. . . . . . . . . . . . . . . . . . . . . . . . . .  18
  77.  
  78. 11.4 Select Colour Scheme. . . . . . . . . . . . . . . . . . . . . . . . .  19
  79.  
  80. 11.5 Calculating Statistics. . . . . . . . . . . . . . . . . . . . . . . .  19
  81.  
  82. 12 Errors and Troubleshooting. . . . . . . . . . . . . . . . . . . . . . .  19
  83.  
  84. Final Word . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  20
  85.  
  86.                                    Foreword
  87.  
  88. This project has taken nearly two years of hard work to complete.  I would
  89. like to express my appreciation of those who support me by their registration
  90. of this software.  This is a Budget Edition designed to give you a feel for
  91. what the software can do.  Although I have made this edition legal as is, I
  92. would strongly encourage you to register a fully functional version if you
  93. intend to use it for cataloging a large collection.  The registered version
  94. will accommodate 4000 cds instead of the limited 75 of this Budget Edition.
  95. Please see the order.frm on the distribution disk.
  96.  
  97. A bit about me: I am a blind student studying at The Flinders  University of
  98. South Australia.  I enjoy listening to music,  playing drums and being a
  99. friend.  I hope to complete my B.Sc.  degree and major in Computer Science and
  100. use this as a basis to  go on writing software to aid the disabled.
  101.  
  102.                                     Credits
  103. Special thanks to:
  104. - The Lord Jesus Christ who is my inspiration and   saviour, to whom I owe
  105.      everything.  (Psalm 139, Galatians 2:20)
  106. -  To my family for their support and patience,
  107. - To Rohan Lewis and Tony Galliford, faithful partners in Australian
  108.      Intelligent Software Services, for suggestions, help with the mouse
  109.      routines, testing of new versions, help with the organisation of the
  110.      print manual, etc.
  111. - To you for choosing this software.
  112.  
  113. IBM is a registered trademark of International Business    Machines
  114. Corporation.                                   Disclaimer
  115.  
  116. I Joseph Dunn, the author of Cd Scan, and Australian Intelligent Software
  117. Services, will not be made liable, under any circumstance, regarding the use
  118. or inability to use this software.  I will not be made liable for any loss of
  119. data or loss of profits even if I am notified of the possibility of such an
  120. event.  This software comes as is, you use it at your own risk.  I have tested
  121. this program as extensively as time has permitted and found it to perform as
  122. documented in this Manual.  If you do find a bug in the program, please report
  123. it.  I will fix any bugs submitted to me in writing.
  124.  
  125.  
  126.                                Copyright Notice
  127.  
  128. The Budget Edition of Cd Scan and its accompanying documentation is copyright
  129. and may not be reverse engineered or modified in any way. It may be freely
  130. distributed provided that the original contents of the distribution archive
  131. file are all distributed together, either as the originally named archive file
  132. or on a diskette in its unpacked form. All files must be included.                                  Introduction
  133.  
  134. Cd Scan is a powerful music cataloguing system specifically  designed for
  135. cataloguing a compact disk collection.  Up to 75 cds each containing up to 99
  136. tracks may be accommodated on this Budget Edition.  The program includes a
  137. powerful and flexible search facility and  a quick scan browse facility which
  138. allows you to quickly browse through your collection.  The index may be sorted 
  139. by either the cd title or the artist name at the press of a key.  A cd's
  140. contents may be displayed, and you may even browse the lyrics of a given track
  141. (if they exist).  The print facility allows you to create title or artist
  142. lists as well as a complete record of your whole catalogue and much more. 
  143. These lists may be printed directly or exported to your favourite word
  144. processor for further editing.  
  145.  
  146. Preparation of recorded material is made easy by Cd Scan's ability to
  147. accumulate selected track times and generate a list of these selections, which
  148. perhaps could be used as a cassette label.
  149.  
  150. A Utilities Menu offers maintenance features like Optimisation to  ensure the
  151. most efficient access to your cd collection, an option to recover deleted cds,
  152. a facility to merge two catalogues together, the ability to select a different
  153. colour scheme and a function to  calculate some statistics about your
  154. collection like average  track time etc.
  155.  
  156. You may also "lock" Cd Scan so that if you are using it in a library or other
  157. public display, data may be protected from unauthorised modification.  
  158.  
  159. Besides Cd Scan's powerful features to make cataloging your cds enjoyable and
  160. efficient, the program will also do its best to protect your data.  Cd scan
  161. will automatically detect a missing or corrupt index and will attempt to
  162. rectify the situation, if it is ever needed.
  163.  
  164. To ensure that you get the most out of this cataloguing system, the User
  165. Manual may be called up from any of the menus at the press of a key (or the
  166. click of a mouse button).
  167.  
  168.  
  169.                     1 Installation and System Requirements
  170.  
  171. To run Cd Scan you need an IBM compatible with at least 384k ram and DOS 2.11
  172. or later.  If you intend to use Cd Scan near full capacity, 640k is required. 
  173. A hard disk is recommended for fastest and  most reliable performance.  Cd
  174. Scan is distributed on a single  floppy disk.  The files on this disk should
  175. be placed in a  directory by themselves.  For the uninitiated, a directory is
  176. a  place on the disk which contains files belonging to a particular  group,
  177. i.e.  all these files belong to Cd Scan and therefore  should be placed in an
  178. area by themselves to distinguish there  function from say your word processor
  179. files.  To make a directory  and place Cd Scan into it do the following:
  180.  
  181. 1.   Exit any application you may be running and get to the DOS  prompt.  It
  182.      may look something like:
  183.      C>
  184. 2.   From this point type:
  185.      CD\
  186.      (after pressing Enter) type:
  187.      MD CD-SCAN
  188.      (after pressing Enter), type:
  189.      CD\CD-SCAN
  190.      (and press Enter again).
  191. 3.   Place the disk with the Cd Scan files on it into drive A and  type:
  192.      COPY A:\*.*
  193.      then press Enter again.
  194. 4.   Once you have been returned to the DOS prompt, you may run  Cd Scan by
  195.      typing the command:
  196.      CDSB
  197.  
  198. See your DOS manual about creating batch files if you wish to run  Cd Scan
  199. from a batch file or see the appropriate documentation if  you wish to run Cd
  200. Scan from a menu program.
  201.  
  202. Any lyrics files must be placed in a subdirectory of cd-scan called lyrics,
  203. I.e.  the directory structure should look like:
  204. c:\cd-scan\lyrics
  205.  
  206.                               2 How Cd Scan Works
  207. Cd Scan maintains two special files on disk, one contains the  main text of
  208. the compact disk data and the other is an electronic  index for quick access
  209. to the cds.  This file basically contains a  reference pointer for all cds. 
  210. You, the user will not directly  come in to contact with either files but you
  211. must be made aware  of their presence and warned not to modify, move or delete
  212. these  special data files.  Cd scan also creates text files for printing or
  213. editing and these will be discussed in a later section.
  214.  
  215.                             3 Starting the Program
  216. To start Cd Scan, just type the command, cdsb, followed by enter from the DOS
  217. prompt.  If you are not in the cd-scan directory, and if this directory is not
  218. in your path, you will have to change to it by typing: cd\cd-scan, first.  A
  219. basic knowledge of DOS is assumed, if you have problems, consult a friend or
  220. the DOS Manual.  You may wish to start the program from a menu system such as
  221. a Shell program, see the relevant documentation for the installation
  222. procedure.  
  223.  
  224. Cd Scan provides a mode of operation suitable for a public library, to prevent
  225. unauthorised modification of data.  To run Cd Scan in "Locked" mode, add the -
  226. l command line option.  In "Locked" mode, you will not be permitted to modify
  227. any data whatsoever.
  228.  
  229. Run Cd Scan by typing the appropriate command, e.g.  cdsb -l,  or by  choosing
  230. it from your menu system.
  231.  
  232. Your screen will clear and a menu box will appear in the middle of your 
  233. screen with the option "3 Browse Cd Index" highlighted.  By pressing  the up
  234. and down cursor keys, or by using a mouse to point to an  option and pressing
  235. the left button once you can move the  highlight bar to any of the six
  236. options.  To select an option, either press the left mouse button again or
  237. press Enter.  Alternatively, you can press the number next to the option to
  238. highlight it and select it in one go.  To cancel an option at any time, press
  239. the Escape key or the  right mouse button.  Options  may be selected from sub-
  240. menus in the same way as the Main Menu,  the first option of each sub-menu
  241. will return you to the Main Menu  as will the Escape key or right mouse
  242. button.  (Options such as  Utilities Menu are examples of sub-menus).  Most of
  243. the instructions you need to operate the program will be displayed on the
  244. Status Line (the last line on the screen).
  245.  
  246. You may view the User Manual by pressing the f1 key or by clicking the left
  247. mouse button while pointing to the message "Press f1 for User Manual". 
  248.  
  249. While viewing the User Manual with Cd Scan's built in text file viewer, you
  250. may search for a particular section by pressing f2 and typing the text to be
  251. located.  
  252. After pressing Enter, the cursor will be located at the beginning of the text
  253. if it is located.  The search facility in the file viewer is case sensitive,
  254. i.e. uppercase and lowercase characters are different.  To locate the next
  255. match, just press f2 followed by Enter.  To exit the User Manual, press Escape
  256. or click the left mouse button while pointing to the esc-exit message.  You
  257. will be returned to the Menu from which you invoked the User Manual.  
  258.  
  259.  
  260.                               4 Entering a New Cd
  261.  
  262. Well, lets get the show on the road! Lets begin by entering a  compact disk
  263. into the system.  Select "Enter a New Cd" by using  the mouse or keyboard as
  264. discussed in the previous section.  Cd  Scan keeps track of several items of
  265. information about your cds.  These are: The Artist, Title, Unique
  266. Identification Code (used when accessing lyric files), Track times, Track
  267. names, and a  short comment about the cd.  If a cd contains various artists
  268. (such as many compilation cds), these may also be recorded.
  269.  
  270. When entering any data, the following keys may be used:
  271. - Left and Right arrow keys: move cursor left or right   one  space,
  272. - Backspace: move the cursor one space to the left and   delete  the character
  273.      there,
  274. - Delete: delete the character at the current cursor    position,
  275. - Ctrl+w: delete to end of word,
  276. - Ctrl+l: kill line (in comment box only),
  277. - Ctrl+y: yank back line (in comment box only),
  278. - Home and End: move the cursor to the first or last character  in the  
  279.      field,
  280. - Insert: toggle between insert or over-strike mode,
  281. - Enter/Tab: give completed data to program,
  282. - Escape: quit operation.
  283.  
  284. Some brief notes:
  285. 1.  The cursor is the flashing square which appears when you are  asked for a
  286.      response and which indicates where the next character  will be placed on
  287.      the screen.
  288. 2.  Insert mode is where characters typed are inserted before  other
  289.      characters on the line rather than over the top of them as  in over-
  290.      strike.
  291. 3.  You will notice that all characters typed will be converted to  uppercase. 
  292.      This feature standardises all data as many publishing  companies can't
  293.      make up their minds about how the information on  cd covers should be
  294.      printed.  If all text is in one case it is  faster to search through.
  295. 4.  The time for a track must be entered in the form mmss (you may omit
  296.      leading zeros, i.e.  355 is the same as 0355 and 50 is the same as 0050. 
  297.      If you press Enter on a time  field it will be left blank.  Some cds
  298.      don't have a record of the  track times.
  299. 5.  Text fields may be up to 60 characters in length and the  comment may be
  300.      up to 5 lines of 60 characters.
  301. 6.   When entering filenames etc, moving the cursor with the arrow keys or
  302.      home/end before typing any characters will enable you to edit the default
  303.      response.  If you just start typing, the default response will be
  304.      replaced by the new characters.
  305. 7.  The left mouse button is interpreted as the Enter key in the  context of
  306.      editing or accepting default responses such as in  filename prompts.  The
  307.      right mouse button is interpreted as the  Escape key at all relevant
  308.      times.
  309.  
  310. The first item you will be asked for is the Artist's name.  If you are
  311. cataloguing a various artist cd, just enter a # as the artist's name.  This
  312. tells the program to prompt you for the artist of each track.  After you have
  313. typed in the Artist name and pressed the Enter  key, (as in all cases of data
  314. entry), Cd Scan will then respond  with a prompt asking you to type the Title
  315. of the cd.  If you make  a mistake during the entry of data and don't realise
  316. it in time  to correct it, i.e.  you've pressed Enter, don't worry, you can 
  317. correct it later.  (see 7.1).  You will then be asked to enter a unique id for
  318. the cd.  You may leave it blank at this stage by just pressing ENTER or
  319. ESCAPE, or you may enter your personal coding scheme.  I use a scheme which
  320. gives each artist a number and for each disk by that artist, a letter, i.e. 
  321. the first disk I purchased had the code 1a, the second by the same artist had
  322. the code 1b etc.  After you have typed in the id of the cd and pressed ENTER,
  323. Cd Scan will check the uniqueness of this code.  If it is found in the index,
  324. you will be asked to "try again".
  325.  
  326. Next, the screen will display a box  with three columns in it and the artist
  327. and title centred above  the box.  This box will become familiar to you as you
  328. use the  program.  This screen will be referred to as the "Display Screen". 
  329. The three columns are the track number (1 to 99), the time  (mm:ss) and the
  330. track name.  You will be asked to Enter the second  two pieces of information,
  331. i.e.  the track duration and name.  If  you don't wish to enter a time in,
  332. leave it blank by just  pressing Enter.
  333.  
  334. If you specified that the cd contained various artists by entering a # at the
  335. first prompt, you will also be prompted for the artist of each track.  If you
  336. leave this field blank, Cd Scan will record it as "NONE SPECIFIED".
  337.  
  338. Once all the tracks have been entered in, press  Enter on a name field and you
  339. will be asked to type in a comment  for the cd.  If you don't wish to include
  340. a comment then just  press Enter until the box disappears or press the Escape
  341. key.  Such information which might be included in the comment box could  be
  342. the copyright date, a favourite song or a music category etc.  Once the data
  343. for a cd has been entered, the program will store  the cd on disk and add its
  344. reference to the index.  A Various Artist cd will be denoted by "VARIOUS
  345. ARTISTS" when browsing the index (See chapter 6).  Cd Scan will  automatically
  346. sort the index each time an addition is made Repeat  this Enter process until
  347. you have several cds in the index.
  348.  
  349.                                5 Exiting Cd Scan
  350.  
  351. If you have had enough for this session and wish to Leave the  program, you
  352. may select this option from the main menu or just  press the Escape key or
  353. right mouse button until you are asked if  this is your real intention.  If
  354. you press Escape again, the  operation will be cancelled and you will not exit
  355. the program.  If  you answer y for yes or hit the left mouse button you will
  356. leave  Cd Scan and return to DOS.
  357.  
  358. Note: For all (y/n) prompts, the right  mouse button is equivalent to a
  359. negative response, i.e.  pressing  "n" or the Escape key while the left button
  360. is equivalent to a  positive response, i.e.  pressing "y".
  361.  
  362.                          6 Browsing Your Cd Collection
  363.  
  364. Once the index contains at least one cd you will be able to  browse.  Select
  365. Browse from the main menu and two boxes will be  displayed, the number of cds
  366. in the index will be written above  these boxes and the bottom line (status
  367. line) will display  several options.
  368.  
  369. The two boxes (or windows) contain a list of artist names and cd  titles.  A
  370. highlight bar will appear marking an artist and title.  You may browse through
  371. the cds using the following keys:
  372.  
  373. - Up/Down: move the highlight bars up or down one cd,
  374. - Pgup/Pgdn: move the bars forward or backward a page at   a  time,
  375. - Home/End: move the bars to the first or last cd in the    index.
  376. - Tab: swap windows and re-sort the index.
  377. - f2, go to cd with a particular id code.
  378. - Escape: return to the main menu.
  379.  
  380. You may also use the mouse to point to a cd and press the left  button to
  381. highlight it.  To display the previous or next screen of  cds using the mouse,
  382. point to the top or bottom border of the  windows and press the left button.
  383.  
  384. Note: the cd highlighted will be referred to as the current cd.
  385.  
  386. As you highlight a cd, its id code (if it has one) will be displayed in the
  387. top right corner of the screen.  You may go straight to a particular cd by
  388. using the "go to" option.  To select this option either press the f2 key or
  389. use the mouse to point to it and click the left button.  You will be asked to
  390. enter a cd id code.  If this code is located, the cd with that code will
  391. become the current cd.
  392.  
  393. To exit the Browse facility, just press the Escape key or the right mouse
  394. button.
  395.  
  396.                            6.1 Re-sorting the Index
  397.  
  398. When you press the Tab key or press the left mouse button when  pointing to
  399. the "tab-swap windows" message on the status line  while browsing the index,
  400. the two windows will be swapped  and the index sorted by whatever is in the
  401. left hand window.  For  example, if the index is currently sorted by the
  402. artist name (the  artist names being displayed in the left hand window), then
  403. these  will be moved to the right hand window and the titles will be  moved to
  404. the left hand window and the index re-sorted.  The  highlight bar will be
  405. placed on the same cd in its new sorted  position in the index.  When you exit
  406. the browse screen, if Cd Scan is not "Locked", any  modifications to the index
  407. will be written to disk so that next  time you browse your collection, the
  408. sort order will be preserved. This doesn't apply if you are browsing the
  409. results of a search.
  410.  
  411.                                6.2 Deleting a Cd
  412.  
  413. If you wish to delete a cd altogether, you can do this from the  browse
  414. screen.  Just make the cd you wish to delete the current  one, i.e.  highlight
  415. it, then either press Ctrl-d or use the mouse  to point to the option and
  416. press the left button as usual.  If Cd Scan is not "Locked", You  will be
  417. asked if you really want to go ahead with the deletion  and then according to
  418. your response, the appropriate action will  be taken.  (Don't worry if you
  419. delete a cd accidentally, you will  be able to undelete it later from the
  420. Utilities Menu.
  421.  
  422.                                7 Displaying a Cd
  423.  
  424. If you press Enter on the current cd or press the left mouse  button while
  425. pointing to the highlighted cd, the familiar box  first encountered in the
  426. "Enter a New Cd" option along with  several other items will be displayed. 
  427. The first time of the  first track will be highlighted.  This highlight bar
  428. indicates the  current track.  You may move this highlight bar up and down
  429. with  the following keys:
  430.  
  431. - Up/Down: move to next or previous track,
  432. - Pgup/Pgdn: move to the previous or next screen of   tracks, 
  433. - Home/End: move to the first or last track on the cd.
  434. - F2/F3: goto next/previous matching track or cd.  
  435.  
  436. You can also use the mouse to highlight a time by pointing to the  track and
  437. pressing the left mouse button.
  438.  
  439. If the cd contains various artists, the usual position for the cd artist will
  440. be replaced by the artist of each track as you scroll through the tracks.  The
  441. words "VARIOUS ARTISTS" will appear above this.
  442.  
  443.                                7.1 Editing a Cd
  444.  
  445. Cd scan allows you to edit the contents of a cd.  This is useful if you find
  446. that you've miss-typed a name or if you missed some information.  You are even
  447. permitted to Reorder the tracks just in case they were printed on the cd cover
  448. in a different order to what they were actually recorded on the cd.  This
  449. option also allows you to add tracks that may have inadvertently been left off
  450. when you initially entered the cd.
  451.  
  452. The edit options are accessed by pressing Alt+e or by pressing the left mouse
  453. button while pointing to the option on the status line.  
  454.  
  455. If Cd Scan is not "Locked", pressing Alt-e or selecting this option with the
  456. mouse will  display options corresponding to the field names that can be 
  457. edited and the options of reordering and adding tracks.
  458.  
  459. You may select:
  460. a -to correct the artist name,
  461. t - for the title,
  462. i - for the id,
  463. n - for the current track name,
  464. c - for the comment or
  465. l - for the length of the current track.
  466. r - to reorder the tracks,
  467. Enter to Add tracks.
  468.  
  469. Remember you can also make a selection using the mouse.  Once a selection is
  470. made, you are permitted to edit the selected  field.
  471.  
  472. If you delete all the characters when editing the name of a track, you will be
  473. asked if you really want to delete the track.  According to your response, the
  474. appropriate action will be taken.  If you delete the track, all other tracks
  475. will be moved up one position.  If you delete all the tracks on the cd then
  476. the empty cd will be deleted from the index and obviously irrecoverable.
  477.  
  478. If the cd contains various artists then selecting a for artist will allow you
  479. to edit the artist of the highlighted track.
  480.  
  481. To reorder the tracks, simply highlight the track you wish to move using the
  482. keyboard or mouse, select the edit options, select reorder, then highlight the
  483. track before which you want to insert, finally, press Enter or press the left
  484. mouse button on the highlighted track.  The initial track will be inserted
  485. before the second track you selected and the rest of the tracks will be
  486. shifted appropriately.
  487.  
  488. You will not be permitted to delete either the title or main artist of the cd,
  489. only edit them.  If you attempt to delete these fields, they will just
  490. miraculously reappear when you press Enter.  
  491.  
  492. When you return to the browse screen by pressing Escape from the display
  493. screen, the changes will be   written  to disk.  The index will be re-sorted
  494. if need be only when you exit the browse screen.  This means that if you edit
  495. the artist or title of a cd which causes them to take a different order in the
  496. index, they will not be moved until you exit the browse screen and go back in
  497. to it.
  498.  
  499.                         7.2 Tagging and Pasting Tracks
  500.  
  501. Once you have a cd displayed on the screen, you may use Cd Scan's functions to
  502. help you compile a radio program, create a tape label or just create a list of
  503. your favourite tracks from your collection.
  504.  
  505. The tag function may be viewed like the Program facility offered on most Cd
  506. Players.  If you tag a track, it is marked for pasting to a text file and its
  507. time is added to the Total Time Box.  You may unmark the track and subtract
  508. its time just by tagging the track again.  Alternatively, if you wish to
  509. create a label containing all but one or two tracks, you only need mark those
  510. two tracks and then use the Invert function to invert the status of all the
  511. tracks on this cd, i.e.  unmark all marked tracks and mark all unmarked tracks
  512. and add the time of just the marked tracks to the Total Time Box.
  513.  
  514. To mark a track and add its time to the Total Time Box, simply make the track
  515. the current one by highlighting it and then by pressing the Space Bar.  To
  516. unmark and subtract this track's time, just press the Space Bar again.  To
  517. perform a tag invert, just press and hold down the Alt key and press the Space
  518. Bar.  As described above, the status of all the tracks will be inverted.
  519.  
  520. The tag facility is also selectable via the mouse as usual.
  521.  
  522. This facility allows the text of the track number, time, name and possibly
  523. artist,  to be added to a text file for later printing or editing.  A "+" or
  524. "*" will be placed in the right margin to  indicate that a track has been
  525. tagged for pasting, depending on whether the track also has a lyrics file
  526. linked to it (see chapter 8).  When you use the Invert function (Alt-Space),
  527. you will notice the indicator symbols (see 8.1) change to reflect the new
  528. status of each track.  When you exit  this screen and return to the browse
  529. index, you will be asked to  enter a filename.  A default name will be
  530. offered, either accept  this name or edit the field to change it.  The
  531. artist's name, cd  title and all tagged tracks will be added to this file.  To
  532. edit this file you must use a text editor of some sort,  although you can
  533. print it as it is from the Print Menu.
  534.  
  535. If this file is not deleted, it will be added to each time you  Paste a track
  536. to it.  You are given the option to delete this file  from the "Print Text
  537. File" option on the Print Menu.  
  538.  
  539. Times will be accumulated as different cds are displayed.  To clear the time
  540. box and unmark all tracks on the displayed cd, press the Delete, (Del), key.
  541.  
  542. Note: Times will not be accumulated above 99:59.  If an attempt is  made to
  543. add times that total more than this, or to subtract times  until total is less
  544. than 0 then an error message will alert you.  The Time box must then be
  545. cleared using Del.
  546.  
  547. Play with this tag function and practice tagging tracks and creating text
  548. files of your favourite songs.  Remember you may even return to the browse
  549. screen by  pressing Enter (or Escape) and selecting another cd.  Notice that 
  550. the time box is not cleared.  Make sure you clear the time box if  you just
  551. want the total of one cd.
  552.  
  553.                          8 Creating and Viewing Lyrics
  554.  
  555. If you have the lyrics to any of the tracks in your collection and wish them
  556. to be displayed when you select the track from the Display Screen, you must
  557. use your favourite editor to create a text file containing the lyrics and
  558. store it in the lyrics subdirectory under the name of idtk.lyr where id is the
  559. unique cd identifier and tk is the track number, e.g.  if the disk id is 1a
  560. and the track is 1 then the file should be called 1a01.lyr.
  561.  
  562. If the lyrics file exists when you select the track, it will be displayed and
  563. you will be permitted to browse through the file using the standard
  564. procedures.  When you exit the file viewer by pressing Escape, you will be
  565. returned to the display screen.  An "X" or "*" will appear in the right margin
  566. when displaying a cd if the track to the left has a lyrics file linked to it. 
  567. When you optimise the catalogue, you will be given the option to update any
  568. links to lyric files, in case new lyrics have been added or files have been
  569. deleted.  If you edit any field while displaying a cd, i.e. if you edit say
  570. the current track name, the lyrics file links will be updated when you return
  571. to the Browse Screen.  An attempt to display a nonexistent lyrics file will
  572. result in an error message.
  573.  
  574. If you re-order the tracks on the cd, the program will automatically check to
  575. see if there are lyrics files which need to be renamed and perform the
  576. appropriate house keeping.  If you delete a track, its lyrics file will be
  577. renamed with the "old" extension and the subsequent tracks will be renamed as
  578. appropriate.  If you edit the cd's id and change it, all lyrics files linked
  579. to that cd will automatically be renamed.  If a cd is deleted, no action is
  580. taken with regard to its lyrics files if they exist.  Except for the house
  581. keeping described above, the maintenance of lyrics files is left up to the
  582. user.
  583.  
  584.                         8.1 Summary of Display Symbols
  585.  
  586. Symbols appearing in the right margin while displaying a cd indicate a tracks
  587. status as follows:
  588.  
  589. A blank indicates that this track has no lyrics file,
  590. An "X" indicates that this track has a lyrics file,
  591. A "+" indicates that this track will be pasted to a text file on exit from the
  592. Display Screen,
  593. A "*" indicates that this track has a lyrics file and will be pasted to a text
  594. file on exit from the Display Screen.
  595.  
  596.  
  597.                                   9 Searching
  598.  
  599. Cd Scan allows you to search for any part of any field in the  catalogue
  600. except the id.  Select "Search Menu" from the Main Menu and you will be  given
  601. the options of searching the different fields.  Select the  field you wish to
  602. search and enter the text to be located.  The text may appear anywhere in the
  603. field.
  604.  
  605. If you select Artist, all various artist cds will also be searched.  
  606.  
  607. Selecting the "Track Length" field allows you to  either search  for all
  608. tracks which are a specific length, which are in a range  of lengths, less
  609. than a given length or longer than a given  length.  Here are some examples of
  610. how track length searches are  entered:
  611.  
  612. 1.  233 - search for all cds containing tracks exactly   02:33  in length.
  613. 2.  <30 - search for all cds containing tracks of   length <  30 seconds.
  614. 3.  >1000 - search for all cds containing tracks with   length >  10 minutes.
  615. 4.  233-302 - search for all cds containing tracks   whose  lengths are in the
  616.      range 02:33 to 03:02   inclusive.
  617.  
  618. An example of entering a time specification is given on the  status line when
  619. you choose this option.
  620.  
  621. Note: Searching by artist or title will be significantly faster as  these
  622. fields are held in memory.
  623.  
  624. Once the search has taken place, the results will be presented in the same 
  625. form as the browse screen.  See chapters 6 and 7.  When you display a cd after
  626. being presented with a list of cds containing matches, the first matching
  627. track will be highlighted if appropriate.  To jump to the next matching track,
  628. press F2 or use the mouse; to jump to the previous matching track, press F3 or
  629. use the mouse.  This facility will only be available if you searched by either
  630. Track Name or Track Length or if the cd has various artists and you've
  631. searched by Artist Name. 
  632.  
  633.                                  10 Print Menu
  634.  
  635. Printing is very useful because it gets the words out of the  computers grubby
  636. hands and onto paper like we are all used to.  The print facility offers you
  637. the options of printing an artist  list containing a list of artist names and
  638. titles, a full compact  disk list containing all the information you entered,
  639. the ability to view or print a text file like the one you  pasted tracks to
  640. (see 7.2), directing the output to a file or to  the printer and sending a
  641. special command string to the printer.
  642.  
  643.                           10.1 Printing the Cd Index
  644.  
  645. Selecting this option will print a list containing the artist  names and
  646. titles of all your cds.  When you select this option, you will be asked to
  647. enter the name of the output file or device.  If you wish to send the list to
  648. the printer, just accept the default name, otherwise, enter a valid filename
  649. to create.  This file may then be imported into a text editor for further
  650. editing.
  651.  
  652. The list will be printed in a  similar form and in the same order as the
  653. browse presentation,  i.e.  if your index is sorted by cd title then the cd
  654. titles will  be in the left column otherwise the artist names will be in the 
  655. left column.  Titles or Artist names of more than 39 characters will be
  656. truncated.  The pages will be automatically numbered and a  heading printed at
  657. the top of each page.
  658.  
  659.                        10.2 Printing the Full Catalogue
  660.  
  661. Selecting this option will print a full listing of all your cds,  i.e.  each
  662. cd will be listed in the order specified by the browse  presentation.  All the
  663. information will be printed including the  comments.  Pages will be
  664. automatically numbered and a heading will  be printed at the top of each page. 
  665. If a cd must be split across a page boundary, a continuation message is
  666. printed after restating the title of the continued cd.
  667.  
  668. When you select this option, you will be asked to enter the name of the output
  669. file or device.  If you wish to send the list to the printer, just accept the
  670. default name, otherwise, enter a valid filename to create.  This file may then
  671. be imported into a text editor for further editing.
  672.  
  673.  
  674.                            10.3 Viewing a Text File
  675.  
  676. Cd Scan offers a facility to view any text file.  You may view a file created
  677. by Cd Scan such as one you pasted tracks to.  After selecting this option,
  678. enter a filename.  If the file is found, you will be permitted to view it
  679. using the usual keys, i.e.  up/down, pgup/pgdn, home/end.  You may search for
  680. text by pressing f2 and typing the pattern to be located.  After you have
  681. entered the search pattern and pressed Enter, the cursor will be placed at the
  682. start of the pattern if it is located.  This search facility is case
  683. sensitive, i.e. the case of the characters typed in must match the characters
  684. in the text exactly if a match is to be found.  To locate the next match, just
  685. press f2 followed by Enter.  To exit the file viewer, press the Escape key. 
  686. This file viewer will enable you to view any strictly text document of up to 4
  687. megabytes in size.
  688.  
  689.                            10.4 Printing a text file
  690.  
  691. If you used the Paste Track facility discussed in section 7.2 then you  may
  692. print the text file created by selecting this option.  If you  select "Text
  693. File", You will be asked for the filename and  offered a default name.  Either
  694. select this name or edit it to  change it.  After printing this  file, you
  695. will be asked if you wish to delete it.  If you respond  affirmatively, the
  696. file will be deleted and any subsequent pastes  will be written to a new file. 
  697. If you respond negatively or just  press Escape, the file will be left intact
  698. and any subsequent  pastes will be appended to the end of the old file.
  699.  
  700.                              10.5 Printer Control
  701.  
  702. When you select this option, you will be prompted to enter codes  to send to
  703. the printer.  You will need to refer to your printer's  documentation to
  704. determine what codes to send.  Once you know what  control codes to send, the
  705. characters can be generated by holding  down the Alt key and pressing the
  706. corresponding number on the  numeric keypad.  For example, to send a Formfeed
  707. character, control code 12, hold down  the Alt key and type 12 on the numeric
  708. keypad then press Enter.  You will be asked if you want to send the string and
  709. according to  your response an attempt is made to send the string to the 
  710. printer.  This facility is useful for setting up your printer for  say a tape
  711. label for which compressed print is appropriate.  If  you have trouble
  712. generating the characters with the numeric  keypad, check the state of your
  713. Numlock key (it should be on).
  714.  
  715.                            10.6 Notes about Printing
  716.  
  717. 1.  The print facility assumes you are using A4 paper and    prints 60 lines
  718.      to a page.
  719. 2.  A printer error will result if you  attempt to print   without paper or if
  720.      the printer is off line.  Press a   key when you have fixed the problem
  721.      or press Escape to    cancel printing.
  722.  
  723.                                11 Utilities Menu
  724.  
  725. This menu offers such facilities as optimisation, undeletion,  merging, colour
  726. scheme selection and statistical  analysis of your collection.
  727.  
  728. Note: If Cd Scan is "Locked" then the only valid options will be Select Colour
  729. Scheme and Calculate Statistics.  Also, the Colour Scheme will not be
  730. remembered when you next use the program.
  731.  
  732.                          11.1 Optimising the Data File
  733.  
  734. Note: If you wish to undelete any cds, this must be done before  Optimise is
  735. selected, see 11.2.
  736.  
  737. Before I discuss what Optimisation does, you need to understand a  bit about
  738. the way Cd Scan stores its information.  I mentioned  earlier about an index
  739. file, a file containing a list of  reference pointers to the main text.  The
  740. index file is generally  the file which undergoes the most modification when
  741. adding or  modifying data.  In fact, when a cd is deleted, its reference 
  742. pointer is just removed from the index and placed in a special  deletion
  743. tracking file allowing undeletion which will be  discussed soon.  The
  744. information stored in the main data file is  not modified in any way, this
  745. eliminates the possibility of disk  error and minimises disk operations.  When
  746. a cd is modified, a new  copy of the cd is added to the end of the data file
  747. and the old  pointer in the index is updated to point to the new copy.  After 
  748. many modifications have been made, the speed of the program may  be affected. 
  749. This is where Optimisation comes in.  What Optimisation does is reads each cd
  750. from the index and writes a  new copy of the data file, writing the cds in
  751. their correct  alphabetic order and eliminating obsolete data.  Optimisation
  752. need  only be performed when many modifications have been made.  Optimisation
  753. also gives you the option of updating links to lyrics files which may have
  754. been added or deleted. 
  755.  
  756. When Optimise is selected from the Utilities Menu you will be asked if you
  757. wish to update links to lyrics files during the operation.  Choosing to update
  758. these links will cause the optimise process to take a little longer.  Before
  759. the optimisation begins, a backup of the  catalogue is automatically made. 
  760. You must not disturb the disk  activity in any way until the Optimisation is
  761. complete or data  may be lost and irrecoverable.
  762.  
  763. Note: With a large catalogue, an XT type computer or a floppy disk  system may
  764. take a while to perform the Optimisation.  Please be  patient and don't
  765. disrupt the operation.
  766.  
  767. After Optimisation has finished, searching and browsing will be  more
  768. efficient and the main data file will probably be smaller.  If something does
  769. go wrong during Optimisation the old files  which were renamed with the bak
  770. extension may be renamed with the  dat extension and the old catalogue
  771. restored.  See your DOS manual  with regard to renaming files.  Installing a
  772. Disk Cache such as SMARTDRV.SYS, which comes with DOS, will speed up
  773. optimisation significantly. 
  774.  
  775.                               11.2 Undeleting Cds
  776.  
  777. If you accidentally deleted a cd or you just decide that you want  back a cd
  778. which has been deleted, and if you haven't Optimised  the catalogue, you may
  779. Undelete it.  When "Undelete Cds" is selected  from the Utilities Menu an
  780. attempt to locate a deletion tracking  file is made.  If found, you will be
  781. asked if you wish to undelete  any cds contained in this file.  If you
  782. undelete the cds at this  point they will be added to the index again and will
  783. be accessible.  If you choose not to undelete the cds at this point  and
  784. decide to Optimise the catalogue they will be lost forever as  the obsolete
  785. data will be removed from the main data file.  (obsolete data includes deleted
  786. cds or old copies of a cd which  have since been modified).  The Deletion
  787. Tracking File DELETED.DAT  will be deleted when the catalogue is Optimised.
  788.  
  789. Note: If you undelete a cd, remember to check its id code as Cd Scan will not
  790. verify its uniqueness.
  791.  
  792.                             11.3 Merging Catalogues
  793.  
  794. This facility allows two catalogues to be merged into one.  If you  know
  795. someone who has already catalogued some cds which you have  obtained and don't
  796. wish to re-type all of the details, you may  incorporate that complete
  797. catalogue into your own.
  798.  
  799. Warning! Read Carefully to avoid disaster: Rename the catalogue files to be 
  800. merged before copying them into your  CD-SCAN directory as  follows:
  801.  
  802. ren cds5.dat Cds5.mrg
  803. ren cds5ndx.dat cds5ndx.mrg
  804.  
  805. Then copy these files to your CD-SCAN directory as follows:
  806.  
  807. copy *.MRG C:\CD-SCAN
  808.  
  809. Finally, run Cd Scan and select "Merge Catalogues" from the Utilities  Menu. 
  810. When you next browse, your index will contain the new  merged catalogues,
  811. sorted the same way as your original catalogue.  You may then delete the .MRG
  812. files.
  813.  
  814. Note: Remember to check the id codes of the merged cds as Cd Scan will not
  815. verify their uniqueness. 
  816.  
  817.                            11.4 Select Colour Scheme
  818.  
  819. This option will cycle through 4 colour schemes, one is suitable for a
  820. monochrome monitor or a lap-top, the others are just varying colour schemes. 
  821. Once you have selected the desired scheme, it will be remembered the next time
  822. you use the program, that is, unless the catalogue is locked.
  823.  
  824.                           11.5 Calculating Statistics
  825.  
  826. When you select this option from the Utilities Menu, Cd Scan will  go away and
  827. calculate some information about your cd collection.  (all the vital
  828. statistics you just were dying to know about and  which will cure your
  829. insomnia, at least for tonight).  The  following information will be presented
  830. in a table:
  831.  
  832.      minimum, average (mean) and maximum track length, minimum, mean and
  833.      maximum cd length, minimum, mean and maximum number of tracks per
  834.      cd, number of cds in index, total number of tracks, Number of tracks
  835.      with lyrics files and approximate playing time.
  836.  
  837.                          12 Errors and Troubleshooting
  838.  
  839. If Cd Scan does not run correctly, check the following:
  840.  
  841. 1.  Your CONFIG.SYS file contains at least 20 files and    buffers.  (See your
  842.      DOS manual for more information)
  843. 2.  Your cds5ndx.dat and cds5.dat files are both present in the  same
  844.      directory as the cdsb.exe file.
  845. 3.  If Cd Scan runs too slow, try Optimising it.  If you have several thousand
  846.      cds, Cd Scan will operate significantly slower than with a smaller
  847.      catalogue.
  848. 4.  If your system locks up on start up, check how much   memory  your system
  849.      has free.  You may have to get rid   of a TSR or  something.
  850. 5.  When the index is either empty or full, you will be    notified.  If full,
  851.      no more cds may be added and if   empty,  there will be no data to
  852.      search, browse or   print.
  853. 6.  A printer error can usually be rectified just by   ensuring  that the
  854.      printer is on line and that the   paper is correctly  aligned.  If you
  855.      still have trouble   printing, consult your  printer manual.
  856. 7.  Note on Deletion: The deletion tracking file, created   when  a cd is
  857.      deleted, is called  deleted.dat.  Do not   delete or  modify this file or
  858.      you will not be able to   undelete any cds.  Do not try to undelete a cd
  859.      from an   obsolete deletion tracking  file as its reference may   not be
  860.      valid.  Suffice to say, don't  try to do the   programs work for it or
  861.      you may find yourself in    trouble!
  862. 8.  When Cd Scan is "Locked" via the -l command line option, the message
  863.      "Access denied" will be displayed when any attempt is made to modify
  864.      data.
  865. 9.   If a lyric file is not found when you select a track, check that you have
  866.      correctly named the file and that the cd has the id you think it should. 
  867.      If a cd has no id, Cd Scan will just look for a file with the track
  868.      number and extension "lyr" as its name.
  869. 10.  The file viewer is strictly for text, it will convert any non-printable
  870.      characters to spaces. You will be able to view any size file up to about
  871.      4 megabytes.  Remember that the search facility in the file viewer is
  872.      case sensitive, i.e. uppercase characters are different from lowercase
  873.      characters. 
  874.  
  875.                                   Final Word
  876.  
  877. This completes the discussion of the Cd Scan cataloguing system.  I  sincerely
  878. hope it meets your cataloguing requirements.  All  suggestions are welcome.
  879.  
  880. For more information about the program or author, all correspondence should be
  881. sent to the address below.
  882.  
  883. Joseph Dunn:
  884.  
  885. 1/58 Murray Terrace,
  886. Oaklands Park S.A.  5046
  887. Australia
  888.  
  889. Phone: +61 8 296-3899
  890.  
  891.                                     THE END
  892.